Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
domains
/
{id}
/
privacy
/
{action_type}
[Domains] Toggle WHOIS privacy protection
curl --request POST \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/domains/{id}/privacy/{action_type} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

​
action_type
string
required
Pattern: ^enable|disable$
​
id
string
required

The unique identifier (UUID) of the domain

​
organization_id
string<uuid>
required
​
project_id
string<uuid>
required

Response

WHOIS privacy toggle task created and queued for processing

​
id
string<uuid>
required
read-only
​
task_type
enum<string>
required
read-only
  • register - register
  • transfer_in - transfer in
  • transfer_out - transfer out
  • renew - renew
  • update_nameservers - update nameservers
  • update_contacts - update contacts
  • get_epp_code - get epp code
  • enable_whois_privacy - enable whois privacy
  • disable_whois_privacy - disable whois privacy
  • lock_domain - lock domain
  • unlock_domain - unlock domain
  • create_dns_zone - create dns zone
  • delete_dns_zone - delete dns zone
  • create_dns_record - create dns record
  • update_dns_record - update dns record
  • delete_dns_record - delete dns record
  • sync_dns_records - sync dns records
Available options:
register,
transfer_in,
transfer_out,
renew,
update_nameservers,
update_contacts,
get_epp_code,
enable_whois_privacy,
disable_whois_privacy,
lock_domain,
unlock_domain,
create_dns_zone,
delete_dns_zone,
create_dns_record,
update_dns_record,
delete_dns_record,
sync_dns_records
​
status
enum<string>
required
read-only
  • pending - pending
  • running - running
  • completed - completed
  • failed - failed
  • cancelled - cancelled
Available options:
pending,
running,
completed,
failed,
cancelled
​
created
string<date-time>
required
read-only
​
started_at
string<date-time> | null
required
read-only
​
completed_at
string<date-time> | null
required
read-only